<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Pod::ParseLink - Parse an L&lt;&gt; formatting code in POD text - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/Pod::ParseLink">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Pod::ParseLink.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/Pod::ParseLink">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/Pod::ParseLink">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/Pod::ParseLink">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/Pod::ParseLink">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/Pod::ParseLink">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/Pod::ParseLink">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/Pod::ParseLink">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/Pod::ParseLink">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/Pod::ParseLink">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/Pod::ParseLink">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/Pod::ParseLink">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/Pod::ParseLink">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/Pod::ParseLink">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/Pod::ParseLink">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/Pod::ParseLink">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/Pod::ParseLink">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/Pod::ParseLink">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/Pod::ParseLink">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/Pod::ParseLink">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/Pod::ParseLink">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/Pod::ParseLink">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/Pod::ParseLink">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/Pod::ParseLink">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/Pod::ParseLink">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/Pod::ParseLink">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/Pod::ParseLink">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/Pod::ParseLink">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/Pod::ParseLink">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/Pod::ParseLink">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/Pod::ParseLink">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/Pod::ParseLink">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/Pod::ParseLink">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/Pod::ParseLink">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/Pod::ParseLink">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/Pod::ParseLink">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/Pod::ParseLink">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/Pod::ParseLink">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/Pod::ParseLink">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/Pod::ParseLink">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/Pod::ParseLink">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/Pod::ParseLink">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/Pod::ParseLink">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/Pod::ParseLink">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/Pod::ParseLink">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/Pod::ParseLink">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/Pod::ParseLink">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/Pod::ParseLink">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/Pod::ParseLink">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/Pod::ParseLink">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/Pod::ParseLink">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/Pod::ParseLink">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/Pod::ParseLink">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/Pod::ParseLink">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/Pod::ParseLink">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/Pod::ParseLink">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/Pod::ParseLink">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/Pod::ParseLink">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/Pod::ParseLink">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/Pod::ParseLink">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/Pod::ParseLink">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/Pod::ParseLink">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/Pod::ParseLink">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/Pod::ParseLink">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/Pod::ParseLink">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/Pod::ParseLink">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/Pod::ParseLink">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/Pod::ParseLink">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/Pod::ParseLink">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/Pod::ParseLink">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/Pod::ParseLink">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/Pod::ParseLink">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/Pod::ParseLink">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/Pod::ParseLink">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/Pod::ParseLink">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/Pod::ParseLink">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/Pod::ParseLink">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/Pod::ParseLink">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/Pod::ParseLink">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/Pod::ParseLink">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/Pod::ParseLink">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Pod::ParseLink.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/Pod::ParseLink">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/Pod::ParseLink">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/Pod::ParseLink">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/Pod::ParseLink">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/Pod::ParseLink">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/Pod::ParseLink">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/Pod::ParseLink">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/Pod::ParseLink">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/Pod::ParseLink">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/Pod::ParseLink">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/Pod::ParseLink">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/Pod::ParseLink">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/Pod::ParseLink">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/Pod::ParseLink">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/Pod::ParseLink">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/Pod::ParseLink">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/Pod::ParseLink">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/Pod::ParseLink">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/Pod::ParseLink">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/Pod::ParseLink">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/Pod::ParseLink">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/Pod::ParseLink">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/Pod::ParseLink">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/Pod::ParseLink">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/Pod::ParseLink">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/Pod::ParseLink">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/Pod::ParseLink">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/Pod::ParseLink">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/Pod::ParseLink">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/Pod::ParseLink">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/Pod::ParseLink">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/Pod::ParseLink">5.35.1</a>
          <a class="dropdown-item active" href="./Pod::ParseLink.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Pod::ParseLink.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="./Pod::ParseLink.html">Pod::ParseLink</a>
          <div id="more">
            (<a href="./Pod::ParseLink.txt">source</a>,
            <a href="https://metacpan.org/pod/Pod::ParseLink">CPAN</a>)
          </div>
            <div id="moduleversion">version 4.14</div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="./Pod::ParseLink.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Pod::ParseLink.html#SYNOPSIS">SYNOPSIS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Pod::ParseLink.html#DESCRIPTION">DESCRIPTION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Pod::ParseLink.html#AUTHOR">AUTHOR</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Pod::ParseLink.html#COPYRIGHT-AND-LICENSE">COPYRIGHT AND LICENSE</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Pod::ParseLink.html#SEE-ALSO">SEE ALSO</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="./Pod::ParseLink.html#NAME">#</a>NAME</h1>

<p>Pod::ParseLink - Parse an L&lt;&gt; formatting code in POD text</p>

<h1 id="SYNOPSIS"><a class="permalink" href="./Pod::ParseLink.html#SYNOPSIS">#</a>SYNOPSIS</h1>

<pre><code>use Pod::ParseLink;
my $link = get_link();
my ($text, $inferred, $name, $section, $type) = parselink($link);</code></pre>

<h1 id="DESCRIPTION"><a class="permalink" href="./Pod::ParseLink.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p>This module only provides a single function, parselink(), which takes the text of an L&lt;&gt; formatting code and parses it. It returns the anchor text for the link (if any was given), the anchor text possibly inferred from the name and section, the name or URL, the section if any, and the type of link. The type will be one of <code>url</code>, <code>pod</code>, or <code>man</code>, indicating a URL, a link to a POD page, or a link to a Unix manual page.</p>

<p>Parsing is implemented per <a href="perlpodspec.html">perlpodspec</a>. For backward compatibility, links where there is no section and name contains spaces, or links where the entirety of the link (except for the anchor text if given) is enclosed in double-quotes are interpreted as links to a section (L&lt;/section&gt;).</p>

<p>The inferred anchor text is implemented per <a href="perlpodspec.html">perlpodspec</a>:</p>

<pre><code class="plaintext">L&lt;name&gt;         =&gt;  L&lt;name|name&gt;
L&lt;/section&gt;     =&gt;  L&lt;&quot;section&quot;|/section&gt;
L&lt;name/section&gt; =&gt;  L&lt;&quot;section&quot; in name|name/section&gt;</code></pre>

<p>The name may contain embedded E&lt;&gt; and Z&lt;&gt; formatting codes, and the section, anchor text, and inferred anchor text may contain any formatting codes. Any double quotes around the section are removed as part of the parsing, as is any leading or trailing whitespace.</p>

<p>If the text of the L&lt;&gt; escape is entirely enclosed in double quotes, it&#39;s interpreted as a link to a section for backward compatibility.</p>

<p>No attempt is made to resolve formatting codes. This must be done after calling parselink() (since E&lt;&gt; formatting codes can be used to escape characters that would otherwise be significant to the parser and resolving them before parsing would result in an incorrect parse of a formatting code like:</p>

<pre><code class="plaintext">L&lt;verticalE&lt;verbar&gt;barE&lt;sol&gt;slash&gt;</code></pre>

<p>which should be interpreted as a link to the <code>vertical|bar/slash</code> POD page and not as a link to the <code>slash</code> section of the <code>bar</code> POD page with an anchor text of <code>vertical</code>. Note that not only the anchor text will need to have formatting codes expanded, but so will the target of the link (to deal with E&lt;&gt; and Z&lt;&gt; formatting codes), and special handling of the section may be necessary depending on whether the translator wants to consider markup in sections to be significant when resolving links. See <a href="perlpodspec.html">perlpodspec</a> for more information.</p>

<h1 id="AUTHOR"><a class="permalink" href="./Pod::ParseLink.html#AUTHOR">#</a>AUTHOR</h1>

<p>Russ Allbery &lt;rra@cpan.org&gt;</p>

<h1 id="COPYRIGHT-AND-LICENSE"><a class="permalink" href="./Pod::ParseLink.html#COPYRIGHT-AND-LICENSE">#</a><a id="COPYRIGHT"></a>COPYRIGHT AND LICENSE</h1>

<p>Copyright 2001, 2008, 2009, 2014, 2018-2019 Russ Allbery &lt;rra@cpan.org&gt;</p>

<p>This program is free software; you may redistribute it and/or modify it under the same terms as Perl itself.</p>

<h1 id="SEE-ALSO"><a class="permalink" href="./Pod::ParseLink.html#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1>

<p><a href="./Pod::Parser.html">Pod::Parser</a></p>

<p>The current version of this module is always available from its web site at <a href="https://www.eyrie.org/~eagle/software/podlators/">https://www.eyrie.org/~eagle/software/podlators/</a>.</p>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
